libostree: Document and annotate some methods to quash g-ir-scanner warnings
authorColin Walters <walters@verbum.org>
Fri, 20 Sep 2013 18:00:31 +0000 (14:00 -0400)
committerColin Walters <walters@verbum.org>
Fri, 20 Sep 2013 18:00:31 +0000 (14:00 -0400)
Since warnings are bad.  Introspection is good.

src/libostree/ostree-deployment.c
src/libostree/ostree-sysroot.c

index 0a64641c95a13a7ca6af4efde2a9a476fc4f65ed..db61c56745ae2115e9767c910fb7ea996a6ce407 100644 (file)
@@ -71,12 +71,24 @@ ostree_deployment_get_bootserial (OstreeDeployment *self)
   return self->bootserial;
 }
 
+/**
+ * ostree_deployment_get_bootconfig:
+ * @self: Deployment
+ *
+ * Returns: (transfer none): Boot configuration
+ */
 OstreeBootconfigParser *
 ostree_deployment_get_bootconfig (OstreeDeployment *self)
 {
   return self->bootconfig;
 }
 
+/**
+ * ostree_deployment_get_origin:
+ * @self: Deployment
+ *
+ * Returns: (transfer none): Origin
+ */
 GKeyFile *
 ostree_deployment_get_origin (OstreeDeployment *self)
 {
@@ -117,6 +129,12 @@ ostree_deployment_set_origin (OstreeDeployment *self, GKeyFile *origin)
     self->origin = g_key_file_ref (origin);
 }
 
+/**
+ * ostree_deployment_clone:
+ * @self: Deployment
+ *
+ * Returns: (transfer full): New deep copy of @self
+ */
 OstreeDeployment *
 ostree_deployment_clone (OstreeDeployment *self)
 {
index e5851ad7f01909d8121346d37991c0c8be5f2db1..df38106997890ba1b556774a245c15f8af68aee5 100644 (file)
@@ -1057,6 +1057,8 @@ _ostree_sysroot_kernel_arg_string_serialize (OstreeOrderedHash *ohash)
  *
  * Find the deployment to use as a configuration merge source; this is
  * the first one in the current deployment list which matches osname.
+ *
+ * Returns: (transfer full): Configuration merge deployment
  */
 OstreeDeployment *
 ostree_sysroot_get_merge_deployment (OstreeSysroot     *self,